Skip to content

Updated README with Contributors and Project Support#67

Open
RehanAhmad25 wants to merge 1 commit into
kunalverma2512:mainfrom
RehanAhmad25:docs/readme
Open

Updated README with Contributors and Project Support#67
RehanAhmad25 wants to merge 1 commit into
kunalverma2512:mainfrom
RehanAhmad25:docs/readme

Conversation

@RehanAhmad25
Copy link
Copy Markdown

@RehanAhmad25 RehanAhmad25 commented May 16, 2026 •
edited by coderabbitai Bot
Loading

This PR adds a contributors section to the README showing contributors , along with live fork and star stats.

Screenshot :

Screenshot 2026-05-16 at 6 25 35 PM

Fixes #66

Summary by CodeRabbit

  • Documentation
    • Added a Contributors section with a contributors image and link
    • Added a Project Support section featuring GitHub Stars and Forks badges

Review Change Stack

@github-actions
Copy link
Copy Markdown

ghost commented May 16, 2026

🚀 PR Received Successfully

Hello @RehanAhmad25,

Thank you for taking the initiative to contribute to this project.

Please ensure that your PR follows all project guidelines properly before requesting review.

⚠️ Important Instructions

  • Maintain proper code quality and structure
  • Do not make unnecessary changes/files
  • Ensure responsiveness across devices
  • Follow existing project conventions strictly
  • Attach screenshots/videos for UI-related changes
  • Resolve merge conflicts before requesting review
  • Avoid AI-generated low quality PRs or copied implementations

📌 Mandatory for GSSoC'26 Participants

Joining the community group and announcement channel is compulsory for all contributors participating through GSSoC'26.

Failure to follow contribution guidelines may lead to PR rejection.

We appreciate your effort and wish you a great open-source journey ahead. ✨

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 16, 2026 •
edited
Loading

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 9e12c502-59bc-4c1b-b39c-4a6939cf97a6

📥 Commits

Reviewing files that changed from the base of the PR and between 4879f17 and 2187d31.

📒 Files selected for processing (1)
  • README.md
📝 Walkthrough

Walkthrough

Added "Contributors" and "Project Support" sections to the README. The Contributors section displays contributor avatars, and the Project Support section displays live GitHub Stars and Forks badges. Both sections are positioned immediately before the License section.

Changes

README Community Engagement

Layer / File(s) Summary
Contributors and Project Support sections
README.md		 Added a new "Contributors" section with an embedded contributor image and a "Project Support" section with GitHub Stars and Forks badges, placed before the License section.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A README once plain, now shines with grace,
Contributors pictured in their rightful place,
Stars and forks now dance in bold display,
Community echoes, "We're here to stay!" ⭐

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely summarizes the main change—adding Contributors and Project Support sections to the README.
Linked Issues check ✅ Passed The PR successfully implements all objectives from issue #66: adds a Contributors section with avatars and a Project Support section with live GitHub stars and forks badges.
Out of Scope Changes check ✅ Passed All changes are directly scoped to the linked issue #66 requirements with no unrelated modifications detected.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add Contributors + Star + Forks in README

1 participant

@RehanAhmad25